Skip to content

[codex] docs: rename callback example getter#3541

Open
abhijeetnardele24-hash wants to merge 1 commit intomicrosoft:v2from
abhijeetnardele24-hash:codex/rename-fetcher-example
Open

[codex] docs: rename callback example getter#3541
abhijeetnardele24-hash wants to merge 1 commit intomicrosoft:v2from
abhijeetnardele24-hash:codex/rename-fetcher-example

Conversation

@abhijeetnardele24-hash
Copy link
Copy Markdown

Summary

  • rename the Fetcher example method from getObject to fetchObject
  • keep the callback parameter guidance unchanged
  • make the example read like callback-based async work instead of a getter returning void

Closes #3501.

Validation

  • docs-only change; reviewed the markdown diff locally

Signed-off-by: abhijeet nardele <234410808+abhijeetnardele24-hash@users.noreply.github.com>
Copilot AI review requested due to automatic review settings April 4, 2026 17:45
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the “Optional Parameters in Callbacks” examples in the Declaration Files Do’s and Don’ts docs to avoid implying that a getter-like method should return void, while keeping the guidance about callback parameter optionality the same.

Changes:

  • Renames the example Fetcher method from getObject to fetchObject in both the WRONG and OK snippets.
  • Keeps the callback signature guidance unchanged, but makes the example read more like async “fetch” work.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Somewhat unfortunate example on void return type on a fetching function

2 participants